/* -*- c-basic-offset: 2; indent-tabs-mode: nil; -*- */
/*
 * FreeDots -- MusicXML to braille music transcription
 *
 * Copyright 2008-2010 Mario Lang  All Rights Reserved.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 3, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details (a copy is included in the LICENSE.txt file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License
 * along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * This file is maintained by Mario Lang <mlang@delysid.org>.
 */
package freedots.braille;

import freedots.music.TimeSignature;

/** The braille representation of a time signature.
 *
 * @see <a href="http://brl.org/music/code/bmb/chap06/index.html">Chapter 6:
 *      Meter and Time</a>
 */
public class BrailleTimeSignature extends BrailleList {
  private final TimeSignature timeSignature;

  public BrailleTimeSignature(final TimeSignature timeSignature) {
    super();
    this.timeSignature = timeSignature;

    add(new NumberSign());
    add(new UpperDigits(timeSignature.numerator()));
    add(new LowerDigits(timeSignature.denominator()));
  }

  @Override public String getDescription() {
    return "A " + timeSignature.toString() + " time signature";
  }
  @Override public Object getScoreObject() { return timeSignature; }
}
